parse-url

What is parse-url?

The parse-url npm package is used to parse URLs and extract components such as protocol, auth, host, pathname, query parameters, and hash. It provides a simple API to break down a URL string into its constituent parts for easy access and manipulation.

What are parse-url's main functionalities?

Parsing the URL

This feature allows you to parse a full URL and returns an object with properties like protocol, resource, user, pathname, hash, search, and query. Each property represents a specific part of the URL.

const parseUrl = require('parse-url');
const parsed = parseUrl('https://www.example.com:8080/path/name?query=value#hash');
console.log(parsed);

Parsing the Query String

This feature specifically focuses on parsing the query string part of the URL and converting it into an object for easy access to each query parameter.

const parseUrl = require('parse-url');
const parsed = parseUrl('https://www.example.com/path/name?query=value&another=thing');
console.log(parsed.query);

Reconstructing the URL

After parsing a URL and potentially modifying its components, this feature allows you to reconstruct the URL back into a string.

const parseUrl = require('parse-url');
const parsed = parseUrl('https://www.example.com/path/name');
parsed.resource = 'www.another-example.com';
const reconstructedUrl = parseUrl.stringify(parsed);
console.log(reconstructedUrl);

Other packages similar to parse-url

url-parse

The url-parse package offers similar functionality to parse-url, allowing for the parsing of URLs into components. It also provides the ability to resolve relative URLs against an absolute base URL, which is a feature not present in parse-url.

qs

While qs is not a direct alternative to parse-url, it provides robust query string parsing and stringifying capabilities. It can be used in conjunction with other URL parsing libraries to handle the query string part of URLs more extensively than parse-url.

urijs

URI.js is a URL manipulation library that provides a fluent API for building, parsing, and manipulating URLs. It offers more features than parse-url, such as URL normalization, resolution of relative paths, and support for punycode and IPv6.

README

parse-url

An advanced url parser supporting git urls too.

For low-level path parsing, check out parse-path. This very module is designed to parse urls. By default the urls are normalized.

:cloud: Installation

$ npm i --save parse-url

:clipboard: Example

// Dependencies
const parseUrl = require("parse-url")

console.log(parseUrl("http://ionicabizau.net/blog"))
// { protocols: [ 'http' ],
//   protocol: 'http',
//   port: null,
//   resource: 'ionicabizau.net',
//   user: '',
//   pathname: '/blog',
//   hash: '',
//   search: '',
//   href: 'http://ionicabizau.net/blog' }

console.log(parseUrl("http://domain.com/path/name?foo=bar&bar=42#some-hash"))
// { protocols: [ 'http' ],
//   protocol: 'http',
//   port: null,
//   resource: 'domain.com',
//   user: '',
//   pathname: '/path/name',
//   hash: 'some-hash',
//   search: 'foo=bar&bar=42',
//   href: 'http://domain.com/path/name?foo=bar&bar=42#some-hash' }

// If you want to parse fancy Git urls, turn off the automatic url normalization
console.log(parseUrl("git+ssh://[e-mail]/path/name.git", false))
// { protocols: [ 'git', 'ssh' ],
//   protocol: 'git',
//   port: null,
//   resource: 'host.xz',
//   user: 'git',
//   pathname: '/path/name.git',
//   hash: '',
//   search: '',
//   href: 'git+ssh://[e-mail]/path/name.git' }

console.log(parseUrl("[e-mail]:IonicaBizau/git-stats.git", false))
// { protocols: [],
//   protocol: 'ssh',
//   port: null,
//   resource: 'github.com',
//   user: 'git',
//   pathname: '/IonicaBizau/git-stats.git',
//   hash: '',
//   search: '',
//   href: '[e-mail]:IonicaBizau/git-stats.git' }

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

parseUrl(url, normalize)

Parses the input url.

Note: This throws if invalid urls are provided.

Params

• String url: The input url.
• Boolean|Object normalize: Wheter to normalize the url or not. Default is true. If false, the url will not be normalized. If an object, it will be the options object sent to normalize-url.

Return

• Object An object containing the following fields:
• protocols (Array): An array with the url protocols (usually it has one element).
• protocol (String): The first protocol, "ssh" (if the url is a ssh url) or "file".
• port (null|Number): The domain port.
• resource (String): The url domain (including subdomains).
• user (String): The authentication user (usually for ssh urls).
• pathname (String): The url pathname.
• hash (String): The url hash.
• search (String): The url querystring value.
• href (String): The input url.
• query (Object): The url querystring, parsed as object.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• delta-screen—delta-screen on npm
• deploy-versioning—Deploy your code keeping older versions.
• eval-spider (by evalsocket)—crawle website
• fuge-runner (by Peter Elger)—[![npm version][npm-badge]][npm-url] [![npm downloads][npm-downloads-badge]][npm-url] [![Build Status][travis-badge]][travis-url]
• git-up—A low level git url parser.
• heroku-wp-environment-sync (by Taneli Heikkinen)—A heroku plugin to sync different wordpress environments.
• hubot-will-it-connect (by gambtho)—Connects hubot with willitconnect, to validate CF's ability to connect to external resources
• kakapo (by devlucky)—Next generation mocking framework in Javascript
• lien—An easy to use web framework for Node.js.
• microbe.js (by Brandon Dail)—A small Node.js framework for simple routing
• native-zip (by kardel)—app内H5应用本地化打包工具，支持增量打包，全量打包
• normalize-ssh (by Zoltan Kochan)—Normalize a SSH URL
• parse-db-uri—Parse database URIs
• parse-dburi (by Diego Guerra)—Parse and stringify a DB URI
• ts-scraper (by Pramod Kumar)—Scarp links present in the website recursively
• tumblr-text (by cobaimelan)— [](https://david-dm.org/ayhan
• url-local—Checks if a given url is a local url or not.

:scroll: License

MIT © Ionică Bizău